Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Signer Quickstart Page #1658

Open
wants to merge 15 commits into
base: master
Choose a base branch
from
Open

Conversation

BowTiedDevOps
Copy link
Collaborator

Description

Add a single page of documentation with condensed information and commands on how to quickly run a signer and become a stacker in order to make it easier to become an active signer.

This PR will also focus on simplifying the information provided on the existent signer/stacker documentation for users that will read the detailed explanations.

@BowTiedDevOps BowTiedDevOps marked this pull request as ready for review October 22, 2024 17:05
@BowTiedDevOps BowTiedDevOps requested a review from a team as a code owner October 22, 2024 17:05

### Download the stacks-signer binary

Official binaries are available from the [Stacks Core releases page on Github](https://github.com/stacks-network/stacks-core/releases). Each release includes pre-built binaries. Download the [latest signer release ZIP file](https://github.com/stacks-network/stacks-core/releases/tag/signer-2.5.0.0.5.2) for your server’s architecture and decompress it. Inside of that folder is a `stacks-signer` binary. Currently, the latest mainnet and testnet versions that you have to use differ.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one is a little tough to be accurate with because:

  • the signer may be released standalone from the stacks-node, in which case your links are fine
  • but, the signer may be included in the stacks-core release - in which case the links will be wrong.

i.e. when 3.0 is released - there will not be a signer-3.0.0.0.0 tag, it will just be 3.0.0.0.0

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as below comment - Currently, the latest mainnet and testnet versions that you have to use differ. is not needed since versions will align on 3.0 release


Official binaries are available from the [Stacks Core releases page on Github](https://github.com/stacks-network/stacks-core/releases). Each release includes pre-built binaries. Download the [latest signer release ZIP file](https://github.com/stacks-network/stacks-core/releases/tag/signer-2.5.0.0.5.2) for your server’s architecture and decompress it. Inside of that folder is a `stacks-signer` binary. Currently, the latest mainnet and testnet versions that you have to use differ.

Assuming a `Linux x64` machine, the commands to download and uncompress the signer binary look like this:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would be more specific here and mention glibc (if a user has a musl sytem, the links will not work for them).
counterpoint is that users using musl by default will generally know they are and recognize the link won't work for them.

i would default to being clear these are for glibc systems

### Download the stacks-node binary
Official binaries are available from the [Stacks Core releases page on Github](https://github.com/stacks-network/stacks-core/releases). Each release includes pre-built binaries. Download the [latest node release ZIP file](https://github.com/stacks-network/stacks-core/releases/latest) for your server’s architecture and decompress it. Inside of that folder is a `stacks-node` binary. Currently, the latest mainnet and testnet versions that you have to use differ.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this is needed - once 3.0 is released (soon), the versions will align

Comment on lines +262 to +263
# Remove unwanted files
find ~/stacks-node -type f ! -name 'stacks-node' -delete
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i wouldn't add this, since the only benefit is saving some disk space (marginal)

Comment on lines +112 to +113
# Remove unwanted files
find ~/stacks-signer -type f ! -name 'stacks-signer' ! -name 'keychain.json' -delete
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i wouldn't add this, since the only benefit is saving some disk space (marginal)

@wileyj wileyj requested a review from a team October 22, 2024 20:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants